LCOV - code coverage report
Current view: top level - src/ev - strand.c (source / functions) Hit Total Coverage
Test: Lely core libraries-2.4.0 Code Coverage Lines: 89 131 67.9 %
Date: 2023-12-20 13:56:29 Functions: 12 14 85.7 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 17 42 40.5 %

           Branch data     Line data    Source code
       1                 :            : /**@file
       2                 :            :  * This file is part of the event library; it contains the implementation of the
       3                 :            :  * strand executor functions.
       4                 :            :  *
       5                 :            :  * @see lely/ev/strand.h
       6                 :            :  *
       7                 :            :  * @copyright 2018-2019 Lely Industries N.V.
       8                 :            :  *
       9                 :            :  * @author J. S. Seldenthuis <jseldenthuis@lely.com>
      10                 :            :  *
      11                 :            :  * Licensed under the Apache License, Version 2.0 (the "License");
      12                 :            :  * you may not use this file except in compliance with the License.
      13                 :            :  * You may obtain a copy of the License at
      14                 :            :  *
      15                 :            :  *     http://www.apache.org/licenses/LICENSE-2.0
      16                 :            :  *
      17                 :            :  * Unless required by applicable law or agreed to in writing, software
      18                 :            :  * distributed under the License is distributed on an "AS IS" BASIS,
      19                 :            :  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      20                 :            :  * See the License for the specific language governing permissions and
      21                 :            :  * limitations under the License.
      22                 :            :  */
      23                 :            : 
      24                 :            : #include "ev.h"
      25                 :            : 
      26                 :            : #if !LELY_NO_MALLOC
      27                 :            : 
      28                 :            : #if !LELY_NO_THREADS
      29                 :            : #include <lely/libc/stdatomic.h>
      30                 :            : #include <lely/libc/threads.h>
      31                 :            : #endif
      32                 :            : #include <lely/ev/exec.h>
      33                 :            : #include <lely/ev/strand.h>
      34                 :            : #include <lely/ev/task.h>
      35                 :            : #include <lely/util/errnum.h>
      36                 :            : #include <lely/util/util.h>
      37                 :            : 
      38                 :            : #include <assert.h>
      39                 :            : #include <stdint.h>
      40                 :            : #include <stdlib.h>
      41                 :            : 
      42                 :            : static void ev_strand_exec_on_task_init(ev_exec_t *exec);
      43                 :            : static void ev_strand_exec_on_task_fini(ev_exec_t *exec);
      44                 :            : static int ev_strand_exec_dispatch(ev_exec_t *exec, struct ev_task *task);
      45                 :            : static void ev_strand_exec_defer(ev_exec_t *exec, struct ev_task *task);
      46                 :            : static size_t ev_strand_exec_abort(ev_exec_t *exec, struct ev_task *task);
      47                 :            : 
      48                 :            : // clang-format off
      49                 :            : static const struct ev_exec_vtbl ev_strand_exec_vtbl = {
      50                 :            :         &ev_strand_exec_on_task_init,
      51                 :            :         &ev_strand_exec_on_task_fini,
      52                 :            :         &ev_strand_exec_dispatch,
      53                 :            :         &ev_strand_exec_defer,
      54                 :            :         &ev_strand_exec_defer,
      55                 :            :         &ev_strand_exec_abort,
      56                 :            :         NULL
      57                 :            : };
      58                 :            : // clang-format on
      59                 :            : 
      60                 :            : struct ev_strand {
      61                 :            :         const struct ev_exec_vtbl *exec_vptr;
      62                 :            :         ev_exec_t *inner_exec;
      63                 :            :         struct ev_task task;
      64                 :            : #if !LELY_NO_THREADS
      65                 :            :         mtx_t mtx;
      66                 :            : #endif
      67                 :            :         int posted;
      68                 :            :         struct sllist queue;
      69                 :            :         const int *thr;
      70                 :            : };
      71                 :            : 
      72                 :            : static void ev_strand_func(struct ev_task *task);
      73                 :            : 
      74                 :            : static inline struct ev_strand *ev_strand_from_exec(const ev_exec_t *exec);
      75                 :            : 
      76                 :            : #if LELY_NO_THREADS
      77                 :            : static const int ev_strand_thrd;
      78                 :            : #else
      79                 :            : static _Thread_local const int ev_strand_thrd;
      80                 :            : #endif
      81                 :            : 
      82                 :            : void *
      83                 :          3 : ev_strand_alloc(void)
      84                 :            : {
      85                 :          3 :         struct ev_strand *strand = malloc(sizeof(*strand));
      86                 :            : #if !LELY_NO_ERRNO
      87         [ -  + ]:          3 :         if (!strand)
      88                 :          0 :                 set_errc(errno2c(errno));
      89                 :            : #endif
      90                 :            :         // cppcheck-suppress memleak symbolName=strand
      91         [ +  - ]:          3 :         return strand ? &strand->exec_vptr : NULL;
      92                 :            : }
      93                 :            : 
      94                 :            : void
      95                 :          3 : ev_strand_free(void *ptr)
      96                 :            : {
      97                 :          3 :         free(ptr);
      98                 :          3 : }
      99                 :            : 
     100                 :            : ev_exec_t *
     101                 :          3 : ev_strand_init(ev_exec_t *exec, ev_exec_t *inner_exec)
     102                 :            : {
     103                 :          3 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     104                 :            :         assert(inner_exec);
     105                 :            : 
     106                 :          3 :         strand->exec_vptr = &ev_strand_exec_vtbl;
     107                 :            : 
     108                 :          3 :         strand->inner_exec = inner_exec;
     109                 :          3 :         strand->task = (struct ev_task)EV_TASK_INIT(
     110                 :            :                         strand->inner_exec, &ev_strand_func);
     111                 :            : 
     112                 :            : #if !LELY_NO_THREADS
     113         [ -  + ]:          3 :         if (mtx_init(&strand->mtx, mtx_plain) != thrd_success)
     114                 :          0 :                 return NULL;
     115                 :            : #endif
     116                 :            : 
     117                 :          3 :         strand->posted = 0;
     118                 :            : 
     119                 :          3 :         sllist_init(&strand->queue);
     120                 :            : 
     121                 :          3 :         strand->thr = NULL;
     122                 :            : 
     123                 :          3 :         return exec;
     124                 :            : }
     125                 :            : 
     126                 :            : void
     127                 :          3 : ev_strand_fini(ev_exec_t *exec)
     128                 :            : {
     129                 :          3 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     130                 :            : 
     131                 :          3 :         ev_strand_exec_abort(exec, NULL);
     132                 :            : 
     133                 :            : #if !LELY_NO_THREADS
     134                 :          3 :         mtx_lock(&strand->mtx);
     135                 :            : #endif
     136                 :            :         // Abort ev_strand_func().
     137   [ -  +  -  - ]:          3 :         if (strand->posted && ev_exec_abort(strand->task.exec, &strand->task))
     138                 :          0 :                 strand->posted = 0;
     139                 :            : #if !LELY_NO_THREADS
     140                 :            :         // If necessary, busy-wait until ev_strand_func() completes.
     141         [ -  + ]:          3 :         while (strand->posted) {
     142                 :          0 :                 mtx_unlock(&strand->mtx);
     143                 :          0 :                 thrd_yield();
     144                 :          0 :                 mtx_lock(&strand->mtx);
     145                 :            :         }
     146                 :          3 :         mtx_unlock(&strand->mtx);
     147                 :            : 
     148                 :          3 :         mtx_destroy(&strand->mtx);
     149                 :            : #endif
     150                 :          3 : }
     151                 :            : 
     152                 :            : ev_exec_t *
     153                 :          3 : ev_strand_create(ev_exec_t *inner_exec)
     154                 :            : {
     155                 :          3 :         int errc = 0;
     156                 :            : 
     157                 :          3 :         ev_exec_t *exec = ev_strand_alloc();
     158         [ -  + ]:          3 :         if (!exec) {
     159                 :          0 :                 errc = get_errc();
     160                 :          0 :                 goto error_alloc;
     161                 :            :         }
     162                 :            : 
     163                 :          3 :         ev_exec_t *tmp = ev_strand_init(exec, inner_exec);
     164         [ -  + ]:          3 :         if (!tmp) {
     165                 :          0 :                 errc = get_errc();
     166                 :          0 :                 goto error_init;
     167                 :            :         }
     168                 :          3 :         exec = tmp;
     169                 :            : 
     170                 :          3 :         return exec;
     171                 :            : 
     172                 :          0 : error_alloc:
     173                 :          0 :         ev_strand_free((void *)exec);
     174                 :          0 : error_init:
     175                 :          0 :         set_errc(errc);
     176                 :          0 :         return NULL;
     177                 :            : }
     178                 :            : 
     179                 :            : void
     180                 :          3 : ev_strand_destroy(ev_exec_t *exec)
     181                 :            : {
     182         [ +  - ]:          3 :         if (exec) {
     183                 :          3 :                 ev_strand_fini(exec);
     184                 :          3 :                 ev_strand_free((void *)exec);
     185                 :            :         }
     186                 :          3 : }
     187                 :            : 
     188                 :            : ev_exec_t *
     189                 :          0 : ev_strand_get_inner_exec(const ev_exec_t *exec)
     190                 :            : {
     191                 :          0 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     192                 :            : 
     193                 :          0 :         return strand->inner_exec;
     194                 :            : }
     195                 :            : 
     196                 :            : static void
     197                 :         20 : ev_strand_exec_on_task_init(ev_exec_t *exec)
     198                 :            : {
     199                 :         20 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     200                 :            : 
     201                 :         20 :         ev_exec_on_task_init(strand->inner_exec);
     202                 :         20 : }
     203                 :            : 
     204                 :            : static void
     205                 :         20 : ev_strand_exec_on_task_fini(ev_exec_t *exec)
     206                 :            : {
     207                 :         20 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     208                 :            : 
     209                 :         20 :         ev_exec_on_task_fini(strand->inner_exec);
     210                 :         20 : }
     211                 :            : 
     212                 :            : static int
     213                 :          0 : ev_strand_exec_dispatch(ev_exec_t *exec, struct ev_task *task)
     214                 :            : {
     215                 :          0 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     216                 :            :         assert(task);
     217                 :            :         assert(!task->exec || task->exec == exec);
     218                 :            : 
     219         [ #  # ]:          0 :         if (!task->exec)
     220                 :          0 :                 task->exec = exec;
     221                 :          0 :         ev_strand_exec_on_task_init(exec);
     222                 :            : 
     223                 :            : #if !LELY_NO_THREADS
     224                 :          0 :         mtx_lock(&strand->mtx);
     225                 :            : #endif
     226         [ #  # ]:          0 :         if (strand->thr == &ev_strand_thrd) {
     227                 :            : #if !LELY_NO_THREADS
     228                 :          0 :                 mtx_unlock(&strand->mtx);
     229                 :            : #endif
     230         [ #  # ]:          0 :                 if (task->func)
     231                 :          0 :                         task->func(task);
     232                 :          0 :                 ev_strand_exec_on_task_fini(exec);
     233                 :          0 :                 return 1;
     234                 :            :         } else {
     235                 :          0 :                 sllist_push_back(&strand->queue, &task->_node);
     236                 :          0 :                 int post = !strand->posted;
     237                 :          0 :                 strand->posted = 1;
     238                 :            : #if !LELY_NO_THREADS
     239                 :          0 :                 mtx_unlock(&strand->mtx);
     240                 :            : #endif
     241         [ #  # ]:          0 :                 if (post)
     242                 :          0 :                         ev_exec_post(strand->task.exec, &strand->task);
     243                 :          0 :                 return 0;
     244                 :            :         }
     245                 :            : }
     246                 :            : 
     247                 :            : static void
     248                 :         12 : ev_strand_exec_defer(ev_exec_t *exec, struct ev_task *task)
     249                 :            : {
     250                 :         12 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     251                 :            :         assert(task);
     252                 :            :         assert(!task->exec || task->exec == exec);
     253                 :            : 
     254         [ -  + ]:         12 :         if (!task->exec)
     255                 :          0 :                 task->exec = exec;
     256                 :         12 :         ev_strand_exec_on_task_init(exec);
     257                 :            : 
     258                 :            : #if !LELY_NO_THREADS
     259                 :         12 :         mtx_lock(&strand->mtx);
     260                 :            : #endif
     261                 :         12 :         sllist_push_back(&strand->queue, &task->_node);
     262                 :         12 :         int post = !strand->posted;
     263                 :         12 :         strand->posted = 1;
     264                 :            : #if !LELY_NO_THREADS
     265                 :         12 :         mtx_unlock(&strand->mtx);
     266                 :            : #endif
     267         [ +  + ]:         12 :         if (post)
     268                 :          4 :                 ev_exec_post(strand->task.exec, &strand->task);
     269                 :         12 : }
     270                 :            : 
     271                 :            : static size_t
     272                 :          3 : ev_strand_exec_abort(ev_exec_t *exec, struct ev_task *task)
     273                 :            : {
     274                 :          3 :         struct ev_strand *strand = ev_strand_from_exec(exec);
     275                 :            : 
     276                 :            :         struct sllist queue;
     277                 :          3 :         sllist_init(&queue);
     278                 :            : 
     279                 :            : #if !LELY_NO_THREADS
     280                 :          3 :         mtx_lock(&strand->mtx);
     281                 :            : #endif
     282         [ +  - ]:          3 :         if (!task)
     283                 :          3 :                 sllist_append(&queue, &strand->queue);
     284         [ #  # ]:          0 :         else if (sllist_remove(&strand->queue, &task->_node))
     285                 :          0 :                 sllist_push_back(&queue, &task->_node);
     286                 :            : #if !LELY_NO_THREADS
     287                 :          3 :         mtx_unlock(&strand->mtx);
     288                 :            : #endif
     289                 :            : 
     290                 :          3 :         size_t n = 0;
     291         [ -  + ]:          3 :         while (sllist_pop_front(&queue)) {
     292                 :          0 :                 ev_strand_exec_on_task_fini(exec);
     293                 :          0 :                 n += n < SIZE_MAX;
     294                 :            :         }
     295                 :          3 :         return n;
     296                 :            : }
     297                 :            : 
     298                 :            : static void
     299                 :         12 : ev_strand_func(struct ev_task *task)
     300                 :            : {
     301                 :            :         assert(task);
     302                 :         12 :         struct ev_strand *strand = structof(task, struct ev_strand, task);
     303                 :         12 :         ev_exec_t *exec = &strand->exec_vptr;
     304                 :            : 
     305                 :            : #if !LELY_NO_THREADS
     306                 :         12 :         mtx_lock(&strand->mtx);
     307                 :            : #endif
     308                 :         12 :         task = ev_task_from_node(sllist_pop_front(&strand->queue));
     309         [ +  - ]:         12 :         if (task) {
     310                 :            :                 assert(!strand->thr);
     311                 :         12 :                 strand->thr = &ev_strand_thrd;
     312                 :            : #if !LELY_NO_THREADS
     313                 :         12 :                 mtx_unlock(&strand->mtx);
     314                 :            : #endif
     315                 :            :                 assert(task->exec == exec);
     316         [ +  - ]:         12 :                 if (task->func)
     317                 :         12 :                         task->func(task);
     318                 :         12 :                 ev_strand_exec_on_task_fini(exec);
     319                 :            : #if !LELY_NO_THREADS
     320                 :         12 :                 mtx_lock(&strand->mtx);
     321                 :            : #endif
     322                 :            :                 assert(strand->thr == &ev_strand_thrd);
     323                 :         12 :                 strand->thr = NULL;
     324                 :            :         }
     325                 :            :         assert(strand->posted == 1);
     326                 :         12 :         int post = strand->posted = !sllist_empty(&strand->queue);
     327                 :            : #if !LELY_NO_THREADS
     328                 :         12 :         mtx_unlock(&strand->mtx);
     329                 :            : #endif
     330         [ +  + ]:         12 :         if (post)
     331                 :          8 :                 ev_exec_post(strand->task.exec, &strand->task);
     332                 :         12 : }
     333                 :            : 
     334                 :            : static inline struct ev_strand *
     335                 :         61 : ev_strand_from_exec(const ev_exec_t *exec)
     336                 :            : {
     337                 :            :         assert(exec);
     338                 :            : 
     339                 :         61 :         return structof(exec, struct ev_strand, exec_vptr);
     340                 :            : }
     341                 :            : 
     342                 :            : #endif // !LELY_NO_MALLOC

Generated by: LCOV version 1.14